Inline docs.
authorMatthias Clasen <mclasen@redhat.com>
Sat, 24 Dec 2005 07:00:47 +0000 (07:00 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sat, 24 Dec 2005 07:00:47 +0000 (07:00 +0000)
2005-12-24  Matthias Clasen  <mclasen@redhat.com>

* gdk/gdkrectangle.c: Inline docs.

ChangeLog
ChangeLog.pre-2-10
gdk/gdkrectangle.c

index 88108ed49f538123293fd4fb812f74110d14a037..9d40ebef11aa28c7a18904a0d646007c0dfd045e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2005-12-24  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/gdkrectangle.c: Inline docs.
+
 Thu Dec 22 18:53:14 2005  Tim Janik  <timj@gtk.org>
 
         * gtk/gtkobject.[hc]: renamed GUnowned to GInitiallyUnowned.
index 88108ed49f538123293fd4fb812f74110d14a037..9d40ebef11aa28c7a18904a0d646007c0dfd045e 100644 (file)
@@ -1,3 +1,7 @@
+2005-12-24  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/gdkrectangle.c: Inline docs.
+
 Thu Dec 22 18:53:14 2005  Tim Janik  <timj@gtk.org>
 
         * gtk/gtkobject.[hc]: renamed GUnowned to GInitiallyUnowned.
index 649521a32ca0f70e9b1518901d3618b9db93a4fb..427dbfd4911e008ebf8199b02bf5ee0233e3637a 100644 (file)
 #include <gdk/gdk.h>
 #include "gdkalias.h"
 
+/**
+ * gdk_rectangle_union:
+ * @src1: a #GdkRectangle
+ * @src2: a #GdkRectangle
+ * @dest: return location for the union of @src1 and @src2
+ *
+ * Calculates the union of two rectangles.
+ * The union of rectangles @src1 and @src2 is the smallest rectangle which
+ * includes both @src1 and @src2 within it.
+ */
 void
 gdk_rectangle_union (GdkRectangle *src1,
                     GdkRectangle *src2,
@@ -47,6 +57,16 @@ gdk_rectangle_union (GdkRectangle *src1,
   dest->y = dest_y;
 }
 
+/**
+ * gdk_rectangle_intersect:
+ * @src1: a #GdkRectangle
+ * @src2: a #GdkRectangle
+ * @dest: return location for the intersection of @src1 and @src2
+ *
+ * Calculates the intersection of two rectangles.
+ *
+ * Returns: %TRUE if the rectangles intersect.
+ */
 gboolean
 gdk_rectangle_intersect (GdkRectangle *src1,
                         GdkRectangle *src2,